Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
NOTE: This is the
legacy TypeScript SDK
, aka the npm packageaptos
. For a more robust SDK and better support, we recommend upgrading to thenew TypeScript SDK
@aptos-labs/ts-sdk. Take a look at the documentation and the migration guide.
The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
pnpm install aptos
You can also use your preferred npm client, such as yarn or npm.
<script src="https://unpkg.com/aptos@latest/dist/index.global.js" />
Then, the SDK can be accessed through window.aptosSDK
.
package.json
files to get you going quickly!Setup an .env
file to configure the URLs.
From the root of this package, run:
rm .env
echo 'APTOS_NODE_URL="http://localhost:8080/v1"' >> .env
echo 'APTOS_FAUCET_URL="http://localhost:8081"' >> .env
To run the full SDK tests, From the root of this package, run:
pnpm test
If you see strange behavior regarding HTTP clients, try running the tests with
--detectOpenHandles
.
To test a single file in the SDK, From the root of this package, run:
npx jest -- <path/to/file.test.ts>
To use the local build in a local project:
// run from the root of this package
pnpm build
// run on your local project
pnpm add PATH_TO_LOCAL_SDK_PACKAGE
To develop in a local environment, you need to use the SDK from the main branch.
Run a local node (run from the root of the repo):
cargo run -p aptos -- node run-local-testnet --force-restart --assume-yes
If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. If neither of these describes what you would like to contribute, checkout out the contributing guide.
FAQs
Aptos SDK
The npm package aptos receives a total of 37,026 weekly downloads. As such, aptos popularity was classified as popular.
We found that aptos demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.